Tangible Software Solutions
C++ to VB Converter Help
Contents
- Folder Conversion
- File & Snippet Conversion
- Code Formatting Options
- Header File Options
- System Headers
- Library Free Function Replacements
- C++ Types to Convert to VB Structures
- Conversion Message Options
- Custom String Replacements
- Type & Member Replacements
- Diagnostic Options
- File Encoding Options
- Additions & Omissions
- Miscellaneous Options
- Copy Constructors and Copy Assignment
Folder Conversion
The Folder Converter tab allows you to convert all C++ code
within a folder. Once the files are converted, you can then view C++ to VB Converter
comments, compare converted code files to original code files, and view the converted
code folder.
The Conversion History listview displays previously converted sources and allows you to
view remaining C++ to VB Converter comments and view the converted code folder.
File & Snippet Conversion
The File & Snippet Converter tab allows you to convert
C++ code snippets or files. From the left side textbox, you can type
or paste code snippets, insert files, or view C++ to VB Converter sample snippets.
Once a file or snippet is converted, you can select and copy the results, save the
results to a file, or search the results.
- Indentation: You can choose whether the converted code
uses tabs or spaces for the leading white space. If you choose tabs for leading white space,
then leading spaces in the original code of the length that you specify are replaced by tabs.
If you choose spaces for leading white space, then tabs in the original code are replaced by
spaces of the length that you specify.
- Arrays: VB allows array specifiers
placed either after the variable name or after the type name in variable and parameter
definitions. C++ to VB Converter will place array specifiers according to your preference.
The default is after the variable name. You can also choose short-form vs.
long-form array initialization - e.g., Dim x(5) As Foo instead of Dim x() As Foo = New Foo(5){}.
The short-form is the default.
- Control Statements: If you
select this option, the converter will break apart control structure statements
(if and while statements) by the main conditions. See the output in the
textbox to see the effect of this option.
- Method Declarations: If you select this
option, the converter will break apart method declarations by the method parameters. See the
output in the textbox to see the effect of this option.
- Method Calls: If you select this
option, the converter will break apart method calls by the method call arguments. See the
output in the textbox to see the effect of this option.
- String Literal Concatenation: If you select this
option, the converter will break apart multiple string literal concatenations to separate
lines. See the output in the textbox to see the effect of this option.
- Other:
- Use single-line 'If' statements: Selecting this option
causes C++ to VB Converter to use the single-line If statement format (e.g., If SomeCondition
Then PerformAction()).
- Shorten declarations to 'As New': C++ to VB
Converter will convert variable declarations containing constructor calls to this short form
if this preference is checked: e.g., Dim x As New Foo() instead of Dim x As Foo = New Foo().
The default is the shorter form.
- Use implicit line continuations: VB10 or later allows
omitting the underscore line continuation in most cases. If you select this option,
the conversion output will omit line continuations (since the converter doesn't usually
break up lines, this mainly applies to attributes and array or collection initializers).
- Add 'For' loop variable names to the closing 'Next' statements:
It's optional to have the For loop variable name tagged to the end of the Next statement.
C++ to VB Converter adds it by default.
- Omit parentheses on default constructor calls: Selecting
this option causes C++ to VB Converter to drop empty argument lists on default constructor calls,
which is preferred by some VB programmers (e.g., "New Foo()" becomes "New Foo").
- Omit the 'ByVal' specifier for parameters: VB10 or later allows
omitting the ByVal specifier on parameters.
C++ to VB Converter will insert it unless you choose to omit it.
- Use generous line spacing: Selecting this option
causes C++ to VB Converter to add blank lines at the beginning and end of all control structures
and block declarations (wherever a brace may have appeared in the original C++ code).
- Missing header files: By default, C++ to VB Converter
will prompt for the location of header files referenced in #include statements.
If you would prefer to have the converter ignore references to header files not found
in the current source code folder or in the 'Additional C++ include folders', you can
check the 'Omit from conversion' option.
- Embedding of header files: By default,
C++ to VB Converter will embed header file code for header files with the
same name as the .c or .cpp file being converted. You can choose to embed
all non-system header files if you prefer or just all non-system header files
specified with quotes. Regardless of which option you select, all non-system
header files are parsed for #define macros and typedef's so that the
appropriate replacements can be made. Also, for code pasted into the
C++ code pane, all non-system header files are embedded.
- Additional C++ #include folders: C++ to VB Converter
will begin searching for #include files in the last selected source code folder,
but you can also specify additional include base paths to search.
- Default system headers: These are system headers
recognized by the converter. System headers are never included in the conversion output.
You can unselect them so that they are not treated as system headers (useful if you have
created header files with the same name and don't want them ignored by the converter).
An asterisk at the end indicates all file names starting with these characters.
- Additional system headers: You can add headers so that
they are also recognized by the converter as system headers and never included in the
conversion output. An asterisk at the end indicates all file names starting with these characters.
C++ Types to Convert to VB Structures
The converter normally converts all C++ classes and
structs to VB 'Class' since this is the closest equivalent to the nearly identical
C++ 'class' and 'struct'. If pointers are never used on a class or struct and all
assigning or construction involving the type is intended to copy the object, then
you may wish to specify that the type should be converted to a VB 'Structure'.
Library Free Function Replacements
C++ to VB Converter is primarily a syntax converter, ignoring
most calls to C/C++ library 'free' functions (library functions which don't belong to a class or struct).
However, you can specify your own custom replacements for these free function calls.
These replacements will occur at the end of the conversion process. You specify the new
method name, the expected number of arguments, and whether to transform the function call
to an instance method call (using one of the arguments as the instance variable), or a
static method call (where you specify a class name in addition to the new method name).
You can also specify conversion to an instance or static property.
Conversion Message Options
On this options dialog, you can customize the comment prefixes
that the converter uses for messages and also toggle the messages that C++ to VB Converter
displays on or off.
You can easily set all or none to display via the 'Select All' and 'Select None' buttons.
Custom String Replacements
C++ to VB Converter allows you to specify your own custom
replacements in the converted VB code. This can be useful for cases where you wish to specify
a replacement for a C++ library data type that isn't handle by C++ to VB Converter.
For each replacement string you can specify the regex option, when to perform the replacement
(pre or post conversion), whether or not to match case, whether to match whole words only,
and whether comments or string literals should be modified. The whole words and string literals
options do not apply if the regex option is selected.
To span mulitple lines, either paste directly into the 'Find' and 'Replacement'
textboxes, or use the escaped characters: \r\n\t.
The "Active" checkbox can be unchecked if you wish to temporarily bypass the replacement.
Replacements are made in the order that they appear on the options dialog. For example,
the second replacement is made to each line of code after the first replacement has already
been made. To change the order of replacements, use the 'Up' and 'Down' buttons.
For an example of the regex option, you could do a custom replacement of "Foo(x)" with "Bar(x)",
where "x" is any argument, by specifying the "Find" field as "Foo(([\sa-zA-Z_$]*))" and the
"Replace" field as "Bar$1". Note that there are differences in various regex engines - the
regex engine used by the converter is .NET System.Text.RegularExpressions.Regex.
Type & Member Replacements
C++ to VB Converter allows you to specify your own custom type and
member replacements in the converted code. This can be useful for cases where you wish to
specify replacements for C++ library member calls of a specific type that are not handled
by C++ to VB Converter.
For each external type, you can specify an optional type replacement and multiple member
replacements. For types, you can specify template/generic types, which may include '?' as
a wildcard type. A wildcard in the replacement type must have a matching wildcard in the
same position in the original type.
e.g., the following will replace all references to type 'Foo' having one 'int' type parameter
with 'Bar', having no type parameters:
original type: Foo<int>
replacement type: Bar
e.g., the following will replace all references to type 'Foo' having one type parameter of any
type with 'Bar', having the same type parameter:
original type: Foo<?>
replacement type: Bar(Of ?)
For each member replacement, you specify the original member name, whether the member is static
or not, and whether the member is a method or a field. You also specify the number of arguments
you expect.
For the replacement member, you specify whether the replacement is static or not, and whether
the replacement is a method or a field. You also specify the new list of arguments and can
add literal arguments. For replacement of static methods with instance members, you also
specify the argument position which corresponds to the object instance for the new instance
member. For replacement of instance members with static members, you specify the new class
name used to call the static member (for static methods, you also specify the position in
the argument list to insert the previous instance qualifier, using the string "instance"
(quotes not included) at the appropriate position in the "new argument list" field).
For example, if you want to replace all instance calls to the 'Foo' type method 'Bar'
where you want the instance qualifier to be the new first argument, you would specify
"instance, a1" (quotes not included) for the "new argument list" field, assuming that there
was one argument in the original method calls.
Diagnostic Options
These options are intended to provide information to
Tangible Software Solutions if a conversion is taking longer than expected.
'Record processing by file' instructs the converter to make a record of the files
processed and the time taken for each process. 'Record the last 100 lines of code
parsed before cancelling conversion' instructs the converter to make a record of the
most recent lines parsed before you cancelled the conversion.
File Encoding Options
The converter detects input file encoding from the byte order
mark (BOM), but if the BOM is missing the converter assumes by default that the file encoding
is UTF-8. You can use this option to specify a different default encoding to use in the absence
of a BOM. Output is written in the same encoding as the encoding detected for the original file,
or your default encoding option if the original coding was not detected via the BOM.
For UTF-8, you can choose whether or not to include the BOM for the output - this is normally
used in Windows environments.
Additions & Omissions
- Add to the top of all converted files: If you add text
for this option, that text will be added to the top of every converted file. This option
does not apply to code snippet conversions.
- Omit code regions for these preprocessor tokens: C++ to VB
Converter will remove regions of code from the conversion output which are in preprocessor
blocks positively conditional on any of these tokens (e.g., #ifdef OMIT or #if defined(OMIT)).
- Copy code unconverted for these preprocessor tokens: C++ to
VB Converter will leave regions of code unconverted which are in preprocessor blocks positively
conditional on any of these tokens (e.g., #ifdef COPY or #if defined(COPY)). Any #elif or
#else blocks following the #ifdef section are removed from the conversion output.
Miscellaneous Options
- Renaming tag for code element conflicts: C++ to VB Converter
must occasionally rename code elements to avoid conflicts. You can choose your own renaming
tag and whether to place it at the beginning or end of the original name when this is necessary.
- Copy non-code files in folder conversions: By default,
the converter does not copy non-code files in folder conversions. If you select this
option, all non-code files are copied to the target folder.
- Expand #define function macros inline: Function-style macros
are expanded inline by default, but you can choose to bypass this behavior. You would normally
bypass this behavior if you plan to rewrite the macros as VB methods.
- Include commented original #define macros in output:
By default the converter leaves the commented original #define macros in the output,
unless you turn off this option.
- Detect copy assignment or construction: By default,
C++ to VB Converter attempts detection of copy assignment and construction. Turn this option
off if you would prefer not to have the converter do this.
- Always convert TRUE/FALSE macros to True/False literals:
By default, C++ to VB Converter converts the TRUE/FALSE macros to the True/False
Boolean literals. If you always want TRUE/FALSE to convert to their actual C values
1 and 0, then check this option.
- Convert BOOL typedef to Boolean: By default,
C++ to VB Converter converts the BOOL typedef to Boolean, but you can choose
to convert this typedef to Integer, which is the equivalent to the
original C typedef.
- Convert char, wchar_t, & char16_t pointers to strings: By default,
the converter converts character pointers to strings. We don't convert char32_t since there is
no equivalent in VB to 32-bit characters.
- Convert char, wchar_t, & char16_t arrays to strings: By default,
the converter converts character arrays to strings. We don't convert char32_t since there is
no equivalent in VB to 32-bit characters.
- Accumulate free functions & fields (not declared in a type) in a single file:
By default, the converter accumulates free functions and fields in a single 'GlobalMembers'
class in a single file. If you uncheck this option, the converter will use a separate
'GlobalMembers' partial class at the end of each file where the items are declared.
- Assume 'using namespace std' for snippet conversions:
By default, the converter assumes that the original C++ code has a 'using namespace std'
statement for code snippet conversions, unless you uncheck this option.
- Combine nested namespaces statements into single VB namespaces:
Until recently, C++ did not allow nested namespaces in a single
namespace statement. This option allows you to have combine older nested C++ namespace
statements into a single VB Namespace statement.
- Convert public fields to automatic properties:
By default, the converter maintains public fields, but with this option you can
choose to convert them to public automatic properties.
- C/C++ file extensions: If you have C/C++ file extensions
other than the default extensions, then add them here.
- Default namespace: C++ to VB Converter will wrap the
converted types with the namespace you specify here if no namespace was used in the original
C++ code.
Copy Constructors and Copy Assignment
In C++, object variable assignment without using pointers
does not perform reference assignment as in VB. Instead these assignments perform a
bitwise copy by default or performs the action specified in a copy constructor or
assignment operator overload specified in the C++ source code. When C++ to VB Converter
determines that an assignment is likely a copy assignment or a call to a copy constructor,
it converts them to the VB equivalent and adds a warning to the converted code.
e.g., the following C++ code:
Foo g;
Foo f = g; //uses the copy constructor of type 'Foo'
f = g; //uses the assignment operator overload of type 'Foo'
converts to the VB equivalent:
Dim g As New Foo()
Dim f As New Foo(g)
f.CopyFrom(g)
The original copy constructor is converted directly to a VB constructor, and the
original assignment operator overload is converted to a 'CopyFrom' method (since
overloading the assignment operator is not possible in VB). C++ compilers automatically
generate both the copy constructor and the assignment operator overload if one isn't
specified in the C++ source code, but C++ to VB Converter will only convert existing
copy constructors and assignment operator overloads and will not create default methods.
You may need to code the copy constructor and/or the 'CopyFrom' method if the original
C++ source code relied on the default methods created by the C++ compiler.
Copyright © Tangible Software Solutions, Inc.